/* ==============================================================================
*
*   Copyright (c) 2010, Pierre Favier
*   All rights reserved.
*
*   NTasking is free software: you can redistribute it and/or modify it
*   under the terms of the GNU General Public License as published by the
*   Free Software Foundation.
*
*   Redistribution and use in source and binary forms, with or without
*   modification, are permitted provided that the following conditions
*   are met:
*
*   -   Redistributions of source code must retain the above copyright notice,
*       this list of conditions and the following disclaimer.
*
*   -   Redistributions in binary form must reproduce the above
*       copyright notice, this list of conditions and the following
*       disclaimer in the documentation and/or other materials
*       provided with the distribution.
*
*   THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
*   WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
*   OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
*   DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
*   BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
*   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
*   TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
*   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
*   ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
*   TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
*   THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
*   SUCH DAMAGE.
*
* ============================================================================== */

namespace NTasking.Internals
{

    /// <summary>
    /// The <see cref="ICallableBase"/> interface defines the methods and properties common to all
    /// objects which can be called (i.e. entries/procedures/functions/entry family members)
    /// </summary>
    internal interface ICallableBase
    {

        /// <summary>
        /// Create a <see cref="MethodCall"/> instance representing a call of the current instance
        /// </summary>
        /// <returns>A <see cref="MethodCall"/> instance representing a call of the current instance</returns>
        MethodCall CreateCall();

    }


    /// <summary>
    /// The <see cref="ISynchronouslyCallable{CallDelegateT}"/> interface defines the methods and properties
    /// common to all objects which can be called synchronously with a given parameter profile
    /// </summary>
    /// <typeparam name="CallDelegateT">
    /// A delegate type representing the calling profile for performing a synchronous call.
    /// </typeparam>
    internal interface ISynchronouslyCallable<CallDelegateT> : ICallableBase
        where CallDelegateT : class // Should be MulticastDelegate but refused by the compiler
    {

        // NOTE: when refactoring, if the name of this method is changed, it must be changed also in a string in
        // SynchronizableAttributes.cs class SynchronizableAttribute method BuildInitializer

        /// <summary>
        /// Retrieve a delegate which can be used to effectively perform a direct call
        /// of the current instance
        /// </summary>
        /// <returns>
        /// A delegate which can be used to effectively perform a synchronous call of the current instance
        /// </returns>
        CallDelegateT SynchronousCall();

    }


    /// <summary>
    /// The <see cref="IAsynchronouslyCallable{CallDelegateT}"/> interface defines the methods and properties
    /// common to all objects which can be called asynchronously with a given parameter profile
    /// </summary>
    /// <typeparam name="ACallDelegateT">
    /// A delegate type representing the calling profile for performing an asynchronous call.
    /// </typeparam>
    internal interface IAsynchronouslyCallable<ACallDelegateT> : ICallableBase
        where ACallDelegateT : class // Should be MulticastDelegate but refused by the compiler
    {

        /// <summary>
        /// Retrieve a delegate which can be used to effectively perform a direct call
        /// of the current instance
        /// </summary>
        /// <returns>
        /// A delegate which can be used to effectively perform an asynchronous call of the current instance
        /// </returns>
        ACallDelegateT AsynchronousCall();

    }


    /// <summary>
    /// The <see cref="ISelectivelyCallable{CallDelegateT}"/> interface defines the methods
    /// and properties common to all objects which can be selectively called with a given
    /// parameter profile
    /// </summary>
    /// <typeparam name="SCallDelegateT">
    /// A delegate type representing the calling profile for performing a selective call.
    /// </typeparam>
    internal interface ISelectivelyCallable<SCallDelegateT> : ICallableBase
        where SCallDelegateT : class // Should be MulticastDelegate but refused by the compiler
    {

        /// <summary>
        /// Retrieve a delegate which can be used to effectively perform a selective call
        /// of the current instance
        /// </summary>
        /// <returns>
        /// A delegate which can be used to effectively perform a selective call of the current instance
        /// </returns>
        SCallDelegateT SelectiveCall(SelectiveCall s);

    }

}
